home *** CD-ROM | disk | FTP | other *** search
/ PC Media 2 / PC MEDIA CD02.iso / share / prog / proclist / proclist.doc next >
Encoding:
Text File  |  1991-03-09  |  4.3 KB  |  91 lines
  1.         PROCLIST is a little utility designed to assist the programmer
  2. using Turbo Pascal.  If you are not writing programs OR you are not using
  3. some kind of Pascal compiler then this program is of absolutely NO use to
  4. you and you may as well erase PROCLIST and this DOC file.
  5.  
  6.         Assuming you are writing source code in Pascal (Turbo or otherwise)
  7. this little program parses your code line-by-line and identifies the
  8. LINE NUMBER in your code where you define or create a procedure or function.
  9. Unlike a lot of cross-reference programs, this one does NOT find every
  10. instance of a call to a procedure or function, but rather only the line
  11. number where you defined the procedure.  It finds the line number where a
  12. block of code like this STARTS:
  13.  
  14.                 Procedure MyProc;
  15.                 var
  16.                         ....
  17.                 begin
  18.                         .....
  19.                         .....
  20.                 end;
  21.  
  22.  
  23. PROCLIST produces a LIST (aha!) of all the procedures in your source code
  24. with the first line number where the procedure is created, like this:
  25.  
  26.               MyFirstProc........[MAINFILE.PAS].............. 445
  27.               MySecondProc.......[MAINFILE.PAS].............. 227
  28.               YourProc...........[XTRAFILE.INC]..............  23
  29.  
  30.  
  31. The list of procedures is sorted alphabetically by name.  PROCLIST then
  32. produces another similar list of FUNCTIONS in your source code.
  33.  
  34.         If you have failed to define any procedures or functions in a given
  35. source code file, PROCLIST will fail to produce anything.  For example,
  36. it is a common programming practice to have an include file where you
  37. declare all the variables you are using, but no procedures or functions
  38. are defined in that file.  In this case PROCLIST will not produce a
  39. printout, although it is a perfectly valid programming practice as far
  40. as your compiler is concerned.
  41.  
  42.         When referencing line numbers, remember that line numbers
  43. shown in the lisiting are RELATIVE to the file being parsed.  If
  44. you elect to have "include" files parsed with the main file, line
  45. numbers shown will be specific for the file noted.  In the example
  46. above line 23 means line 23 in the file XTRAFILE.INC and NOT with
  47. reference to line numbering in MAINFILE.PAS.
  48.  
  49.         PROCLIST is menu driven and easy to use.  When the first directory
  50. screen comes up, you can type and enter "*.pas" or "*.inc" etc. (without
  51. the double quotes) to filter the directory list.  Press <Esc> at any time
  52. to instantly abandon PROCLIST.
  53.  
  54.         You can sort the directory list on the screen by pressing any of
  55. several Alt-key combinations, such as Alt-S to sort by size of file.  Press
  56. F1 to see a Help screen of all the various Alt-key combinations.  To use these
  57. keys hold down the key labeled Alt and press the other key at the same time.
  58.  
  59.         You can choose whether PROCLIST's output is sent to the printer
  60. or to a disk file.  If you choose printer, please be sure your printer
  61. is on line, etc.  If you send it to a diskfile, PROCLIST creates a text
  62. file with the extension .PFX (procedure-function crossref).  In our
  63. example, the file MAINFILE.PFX would be written.
  64.  
  65. **************************************************************************
  66.  
  67.         There are no fees requested or expected for PROCLIST.  This one is
  68. on the house.
  69.  
  70.         If you do a lot of programming and debugging you may find our
  71. utilities SHORTQ and FILEQ of benefit.  PROCLIST is actually a modified
  72. module from SHORTQ.  SHORTQ and FILEQ will print your entire source code
  73. file to printer with page headers, page numbers, with or without line
  74. numbers, with or without include files and then produce a PROCLIST type
  75. report at the end.  (In the case of SHORTQ, the proclist reports reference
  76. page number in the printed listing rather than line numbers because it's
  77. easier to flip to a page to see your procedure code.)  SHORTQ supports
  78. other languages besides Pascal (i.e., the page header), but it won't
  79. cross reference functions for any language but Pascal.
  80.  
  81.         SHORTQ may also be available wherever you got PROCLIST.
  82.  
  83.         FILEQ does what SHORTQ does for a QUEUE of files.
  84.  
  85.         Write and ask about our other utilities.
  86.  
  87.                         John A. Abele
  88.                         114 Woodlawn Ave.
  89.                         Willow Grove, Pa.  19090
  90.  
  91.